Skip to content

updated intro page for SGW #885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jul 28, 2025
Merged

Conversation

iamfortune
Copy link
Contributor

@iamfortune iamfortune commented Jul 1, 2025

Docs Issue: DOC-13353

Docs Preview: URL

You will need the Docs Team credentials on Confluence.

@iamfortune iamfortune requested review from bbrks, idulo and simon-dew July 1, 2025 15:05
iamfortune and others added 5 commits July 3, 2025 11:01
This requires ui prod-213, and an asciidoc hack with empty section to close
out the previous flex basis :sadpanda:
Copy link
Contributor

@torcolvin torcolvin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all looks technically correct to me from a developer perspective.

There are a few things I would rather not highlight on the starting page, such as Indexing vs Views. Is the intention to have a full TOC on the starting page, or just show common and useful information?

If the intention is to show useful information, I will have more comments. If the intention is to be a TOC of all the stuff in the sidebar, then some sections are missing. e.g. Deploy in the sidebar has more items than in the main page.

@iamfortune iamfortune assigned torcolvin and unassigned torcolvin Jul 18, 2025
@idulo
Copy link

idulo commented Jul 24, 2025

At a high level, I think the links part after Getting Started, this overlaps with Start Here: Quick Links, what's the plan there? Perhaps we either remove Quick Links or move the overview links pat there? I think the overview introduction bit is more comprehensive than before. We spoke about bringing back the diagram as it is useful for users to reason about how Sync Gateway fits into the Couchbase ecosystem and what is purpose is as a component.

@iamfortune iamfortune removed request for bbrks and simon-dew July 28, 2025 10:04
@iamfortune
Copy link
Contributor Author

I have updated this page to reflect what we discussed, I have also updated the preview URL @idulo.

@iamfortune iamfortune requested a review from bbrks July 28, 2025 11:42
@iamfortune iamfortune merged commit 55e5981 into release/3.2 Jul 28, 2025
2 checks passed
@iamfortune iamfortune deleted the DOC-13353-update-SGW-intro-page branch July 28, 2025 12:36
@iamfortune iamfortune restored the DOC-13353-update-SGW-intro-page branch July 28, 2025 13:40
@iamfortune iamfortune deleted the DOC-13353-update-SGW-intro-page branch July 28, 2025 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants